Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Patch 1 #2

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Patch 1 #2

wants to merge 7 commits into from

Conversation

WenNg
Copy link
Collaborator

@WenNg WenNg commented Oct 21, 2024

Edited sip-validator to better align with DLP metadata requirements and Virginia Tech Digital Library Submission Information Package by updating required fields, adding validation for specific fields, and improving folder checks. The script now flags missing folders, validates special characters in folder names and identifiers, and ensures compliance with controlled values for rights or license and visibility.

What does this Pull Request do? (:star:)

This aims to improve the sip-validator by ensuring better compliance with metadata and SIP requirements. It resolves issues with incorrect folder validation, adds robust checks for required fields, and validates controlled values for rights, license, and visibility. It also flags missing folders, invalid special characters, and ensures metadata conforms to expected standards.

What's the changes? (:star:)

A in-depth description of the changes made by this PR. Technical details and possible side effects.

  • Adjusted folder acceptance as per preservation guidelines.
  • Edited required metadata fields (identifier, title, rights - only for item_metadata.csv, and visibility).
  • Added validation for controlled values in rights or license, and visibility fields.
  • Validated special characters for identifier and folder names.
  • Removed date field validation.

How should this be tested?

  1. Save the script as sip-validator.py.
  2. Run the script in a terminal or command prompt: python3 sip-validator.py
  3. Enter the path to the SIP root folder when prompted.

Interested parties

Tag (@ mention) interested parties

(:star:) Required fields

WenNg and others added 7 commits August 26, 2024 11:57
1. removed previously required field 'description', and 'rights_holder',
2. added required field for 'visibility' and either 'rights' or 'license'.
3. doesn't validate against date field
4. validate accepted value (URI) for both rights and license
Accepted Supporting Information and readme folder, excluded special character check for folder names (case insensitive), restricted special characters in identifiers, check for readme file in root or readme folder.
Upload the file with exact same filename later.
Accepted 'Supporting Information' and 'readme' folder, excluded special character check for folder names (case insensitive), restricted special characters in identifiers, check for readme file in root or readme folder.
Removed case sensitivity for 'identifier', refined special character validation for 'identifier' and folder names, and allowed spaces in folder names.
- Ensured special character validation only applies to actual folders before checking if folder is extra.
- Added validation for the 'visibility' field to accept only 'true' or 'false' (case-insensitive).
- Enforced that item_metadata.csv must contain either rights or license, validated against controlled values.
Update README.md according to updated sip-validator
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant